home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / 15rpch33.arc / SYSOP.DOC < prev   
Text File  |  1988-09-28  |  8KB  |  184 lines

  1. CB
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                  DOORPCH 3.3 DOOR Operational Information for SysOps
  8.  
  9.                                  September 23, 1988
  10.                                          By
  11.                            Clint Labarthe & Terry Shockley
  12.  
  13.  
  14.  
  15.                                    SysOp Operation
  16.  
  17.  
  18.           Please include the following information with any DOOR you write
  19.           which uses DOORPCH 3.3.  The SysOp will require the information.
  20.  
  21.                                      DOOR Setup
  22.  
  23.           Make a batch file to run the DOOR as described in your PCBoard
  24.           (R) documentation.
  25.  
  26.                                       Example:
  27.  
  28.           CD \DOORS
  29.           TGTRIVIA TGTRIV1.CFG  <== Runs TGTRIVIA.EXE passing a parameter
  30.                                     of TRIVIA1.CFG
  31.           CD \PCB                   An example of this file is below.
  32.           BOARD
  33.  
  34.  
  35.                              Example xxxxxxxx.CFG file:
  36.  
  37.           C:\PCB\PCBOARD.SYS          <== The location of this file
  38.           The Computer Playroom BBS   <== The name of your BBS
  39.           Ben                         <== The SysOps FIRST name
  40.           Perron                      <== The SysOps LAST name
  41.  
  42.  
  43.                                 Environment Variables
  44.  
  45.  
  46.           Two environment variables must be set in your AUTOEXEC.BAT file:
  47.  
  48.           SET LIB=<drive:><path to DORPCH33.EXE>  Note: ONLY the PATH !
  49.  
  50.           Example:  SET LIB=C:\MYLIB
  51.  
  52.           The DORPCH33.EXE run-time library must then be placed in this
  53.           directory.  If you keep the library in the <current directory>
  54.           with the DOOR program then this environment variable is NOT
  55.           required.  I would suggest a separate directory - perhaps a
  56.           RAMDISK as I do on my system.
  57.  
  58.  
  59.           SET DOORPCH=PCB     This variable tells DORPCH33.EXE it is
  60.                               running on a PCBoard system
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.           All DOORPCH 3.3 DOORS require the DORPCH33.EXE run-time library
  68.           and the Microsoft (R) QuickBASIC 3.0 run-time library,
  69.           BRUN30.EXE, be present.  Your DOOR program may have come with
  70.           these files in the ARC file.  If they are not present, this DOOR
  71.           program WILL NOT RUN.  You should contact the DOOR author if the
  72.           files are missing.  You require one and only one version of these
  73.           two libraries for ALL DOORPCH 3.3 DOORware.  The files are also
  74.           available in DORPCH33.ARC available on most PCBoard Bulletin
  75.           Board Systems.  If you wish a fully detailed explanation of how
  76.           DOORPCH operates with DOORS, then you may read the documentation
  77.           within the DORPCH33.ARC file within which this documentation may
  78.           be found.
  79.  
  80.  
  81.                                    DOOR Operation
  82.  
  83.  
  84.  
  85.           When the DOOR is in operation you have complete control over the
  86.           caller.  This DOOR was written using DOORPCH version 3.3.  The
  87.           logic is safe.  However, if something goes wrong - like real bad
  88.           wrong, sorry but we probably can't help.  Every precaution has
  89.           been taken to insure this code works flawlessly.  If it doesn't,
  90.           let us know.  Many function/operational keys are at your
  91.           disposal/use:
  92.  
  93.           F1   -    Displays the version of DOORPCH compiled and linked
  94.                     into the DOOR.
  95.           F2   -    Displays a callers Alias if one is used via the Door
  96.                     Monitor program (DOORPCH version) - future.
  97.           F3   -    Reserved for the future.
  98.           F4   -    Toggles the Bell on/off. May activate the DOOR Bell.
  99.                     Value is returned to PCBoard when DOOR completes.
  100.           F5   -    DOS Shell. Allows SysOp to exit to DOS from inside a
  101.                     DOOR.
  102.           F6   -    Displays available MEMORY and available STRING space.
  103.           F7   -    Toggle the alarm on/off. May activate the DOOR Alarm.
  104.                     Value is returned to PCBoard when DOOR completes.
  105.           F8   -    Returns the caller involuntarily to PCBoard.
  106.           F9   -    Toggles the display on/off.
  107.                     Value is returned to PCBoard when DOOR completes.
  108.           F10  -    Activates SysOp / Caller CHAT mode within the DOOR.
  109.           ESC  -    Deactivates CHAT mode. DOOR is resumed.
  110.           HOME -    HELP key for line 24/25 capabilities.
  111.           END  -    Displays Callers name and miscellaneous information.
  112.           PG-DN-    Displays Data Phone, Home Phone, Password,
  113.                     User Comments and SysOps Comments.
  114.           PG-UP-    Displays Conference caller may access.
  115.           UP -      Allows the SysOp to temporarily add additional time
  116.                     to the caller while in the DOOR. This time is NOT
  117.                     returned to the BBS.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.           DN -      Allows the SysOp to temporarily subtract time from the
  124.                     caller while in the DOOR. This time is NOT returned
  125.                     to the BBS.
  126.           ALT-N -   SysOp next on control/indicator.
  127.                     Value is returned to PCBoard when DOOR completes.
  128.           ALT-X -   PCBoard will exit after current caller completes their
  129.                     session.  Value is returned to PCBoard when DOOR
  130.                     completes.
  131.  
  132.           If you are running in NON-GRAPHICS mode, you MUST have ANSI.SYS
  133.           installed as a device driver in your CONFIG.SYS file:
  134.  
  135.                               Example: DEVICE=ANSI.SYS
  136.  
  137.           DOORPCH uses this device driver for displaying all colors to the
  138.           local console.  Color Graphics will always be sent to the local
  139.           console if you have defined to PCBSetup that you are running
  140.           graphics on the local monitor.  If a caller is in non-graphics
  141.           mode (NG) on line 25,  you will still see colors if PCBSetup has
  142.           been configured  that way.  The reverse is also true.  If the
  143.           caller is in graphics mode (GR) on line 25) and the local console
  144.           is defined to be in non-graphics mode then colors will NOT be
  145.           displayed to the local console.
  146.  
  147.                                         MUSIC
  148.  
  149.           This DOOR program may utilize ANSI music.  If it does, and you
  150.           are running in a NETWORK, DOORPCH does not send ANSI music to the
  151.           local console.  We have found that under some Multi-Tasking
  152.           operating systems such as DoubleDOS that the "partition" locks up
  153.           until the music completes.  If you are on a single node system
  154.           (not in a network), then music will be played to the local screen
  155.           if the local screen is active (F9 ON).
  156.  
  157.                                         BELL
  158.  
  159.           DOORPCH logic will not allow a BELL to be sent to the local
  160.           console when the local screen is inactive (F9 OFF).  This, of
  161.           course, assumes the DOOR author follows the DOORPCH rules.
  162.           
  163.  
  164.  
  165.  
  166.  
  167.  
  168.                                        ERRORS
  169.  
  170.           All errors should recover and cause the DOOR program to exit
  171.           gracefully and return to the main system.  All errors are logged
  172.           in the "DOORPCH.ERR" file. The error number and line number are
  173.           included with the date and time.  Errors will be either caused by
  174.           the main module (the authors code, contact him) or the doorpch
  175.           sub (contact DOORPCH people).  It should NEVER cause the board to
  176.           hang.  If your board hangs, you are obligated to contact the
  177.           appropriate party and report the error and circumstances that
  178.           caused it.  Because we are using Microsoft's (c) QuickBASIC 3.0
  179.           run-time routines, it is possible that basic will detect a fatal
  180.           error condition.  As mentioned above, we have taken every
  181.           precaution, but simply cannot code for every error condition.  If
  182.           the DOOR author follows all the rules, the Door should run
  183.           without error.
  184.